home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 001-025 / scopedisk12 / utilmas67 / util.docs < prev    next >
Text File  |  1995-03-18  |  20KB  |  427 lines

  1.  
  2.  
  3.         UtiliMaster
  4.  
  5.     Programable buttons!
  6.     ARC Won't hang up on duplicate files!
  7.     Two windows (Source & Destination)!
  8.     Modify "Standard" buttons!
  9.     Icon doubles as configuration file!
  10.     Run from Workbench or CLI!
  11.  
  12.     The left display window is ALLWAYS the source, the right
  13.         destination. The box above each display shows the current
  14.         directory being displayed. The box below is the  Disk
  15.         or Device name, and the box below the destinatio window
  16.         is the Entry (or "E") box.
  17.     Swapping a disk while it's directory is
  18.     being displayed will automatically get the parent
  19.     directory of the new disk in the appropriate window.
  20.  
  21.     To move into a sub-directory, "Double-Click" it's name. 
  22.     (The time between two clicks to be considered double-clicking
  23.     is determined by Preferences.) To move to the parent of
  24.     the current directory, Double-Click the directory name
  25.     box (Above the list window). Double-Clicking the root
  26.     directory will cause Utilimaster to get it from the device
  27.     again. (This is useful if something outside Utilimaster
  28.     has changed you directory listing.)
  29.     If a symbol like a capital Y with a line thru it appears
  30.     just to the left of the filesize, that file is protected
  31.     to some state other than "rwed". If a C in a circle
  32.     appears, the file has a comment attached to it.
  33.  
  34.     Standard buttons:
  35.  
  36.     "Swap" Will swap the source and destination directories. Files
  37.         may not be selected in the destination window other than
  38.         Double-Clicking sub-directories. If source and
  39.         destination are swapped, selected files are not
  40.         highlighted in the destination window, but will
  41.         be remembered and highlighted in the source window
  42.         if directories are swapped back.
  43.  
  44.     "All" Selects all files in source directory.
  45.     "AllDirs" Selects all sub-directories in source directory.
  46.     "Exchange" De-selects all selected and selects all unselected.
  47.     "ExcDirs" Same for directories.
  48.     "Clear" De-selects all selected files.
  49.     "ClrDirs" Same for directories.
  50.     "Copy" Copies all selected files and sub-directories (including
  51.         files in sub-directories) to destination directory.
  52.         Copy also copies file comments, and if "LOCK" is active,
  53.         (The title bar displays a capital L), protection
  54.         on the copy is set to the same as the orriginal. (If
  55.         protection on the orriginal is "r-e-" then the copy is
  56.         set to "r-e-".)
  57.         If UPDATE is active,(There's a u with dots above in the
  58.         title bar),  in the tooltypes, UtiliMaster will
  59.         look for the file in the destination directory. If it
  60.         exists, but is older, or doesn't exist, it will be 
  61.         copied, and dated the same as the orriginal.
  62.         If it exists and is the same date or newer
  63.         you will be notified that "File xxx is up to date".
  64.         If UPDATE is off, all files are copied, and have 
  65.         the current system date as thier creation date.
  66.         If you enter a FileName in the "E" box, and copy
  67.         a file, it will be renamed in the destination directory.
  68.         In this case, copy stops after the first FileName if
  69.         more than one is selected.
  70.     "Rename" Will rename the FIRST selected file or directory to
  71.         the name in the "E"(Entry) box. If no name appears
  72.         in the "E" box, a requester appears requesting the 
  73.         new file name.
  74.     "Move" If destination directory is on the same device as source,
  75.             selected files will be moved into destination directory.
  76.             If not on the same device, an error message is displayed.
  77.     "Delete" Will present a requester asking if you are sure. Given
  78.         an affirmative, it will delete selected files. Selected
  79.         directories will be automatically deleted if empty.
  80.         For directories containing files, a requester appears
  81.         to remind you if they are not empty. Given an OK,
  82.         these directories, and all files and sub-directories
  83.         will be deleted. Empty directories are deleted with-
  84.         out any requester. (The theory is that an empty
  85.         directory is easy to re-create.)
  86.     "Lock" Changes the protection on selected files/directories to
  87.         "r-e-". They are protected from being written to or
  88.         deleted. Lock will protect all files in selected
  89.         directories. Lock fails if there is a system file-
  90.         lock on a file or directory. If a particular directory
  91.         repeatedly fails to lock, it may have something "assigned"
  92.         to it, or may be part of the "path" list.
  93.     "UnLock" Changes protection to "rwed".
  94.     "Read" Displays the selected file(s) to the screen. ASCII files
  95.         are displayed in text mode, binary etc. are displayed
  96.         as if "c:type opt h" were used, except that the decimal
  97.         file position is listed on the right side of the screen.
  98.         The Up & Down arrows, or scrollbar may be used to move
  99.         forward or backward thru the file. The window-close
  100.         gadget exits read. For keyboard instructions, select
  101.         a file, click "Read", and once the file is displayed,
  102.         push the "HELP" key. The choice of modes is based on
  103.         whether any 0 bytes are found. (ASCII text files
  104.         SHOULD NOT contain any 0 bytes!)
  105.     "FileNote" Attaches whatever is in the "E" box (Even a null
  106.         string!) as a comment to each selected file REPLACING
  107.         any existing comment. Using FileNote with the "E" box
  108.         empty will delete any existing comment.
  109.     "GetNote" Displays the comment on selected file(s) in the
  110.         Status box and the Filename in the "E" box. There is
  111.         a brief delay built in so you have a chance to read
  112.         them if more than one file is selected. Note that
  113.         commented files display a c in a circle just to the
  114.         left of their size in the display window.
  115.     "Print" By default, if Utilimaster can find a file named
  116.         "c:print" it will be RUN and passed the filename, if
  117.         not, an internal routine will print the file to PRT:.
  118.         The default external print routine can be changed.
  119.         See "Setting Defaults", below.
  120.     "Show" By default uses "c:show" to display the selected file(s).
  121.         Show can also be re-defined.
  122.     "Search" By default opens a window and calls "c:search" passing
  123.         it the content of the "E" box as the string to seek,
  124.         and selected file(s) to search.
  125.     "Arc" "DeArc" & "ListArc" by default all use "c:arc".
  126.             "Arc" opens a window and Executes
  127.            "c:Arc a Filename <FileName> <FileName>" for selected
  128.            file(s).
  129.     "DeArc" Opens an interactive window and Executes
  130.            "c:Arc x FileName".  If duplicate files are found,
  131.            this version of UtiliMaster DOES NOT lock up in
  132.            the endless loop most others do!
  133.     "ListArc" Opens a window and Executes
  134.            "c:arc v FileName" The window remains open for
  135.         reading until you close it.
  136.     "Run" Is equivelant to typing "run > nil: FileName" from CLI.
  137.         No window is opened for your file by UtiliMaster.
  138.     "Edit" Defaults to "run e FileName"
  139.     "Execute" Defaults to "Execute FileName"
  140.     "GetDir" Gets the directory in the "E" box, which MUST begin
  141.         with a device name. If the "E" box is empty, the current
  142.         source directory is up-dated. Usefull if you have added
  143.         or deleted a file from some other program.
  144.         To get a sub-directory in a window, Double-Click on that
  145.         directory's name. To get the parent of any displayed
  146.         sub-directory, Double-Click on the Directory
  147.         name box at the top of the listing window.
  148.     "MakeDir" Will make a directory with the name in the "E" window.
  149.         If nothing appears in the "E" window, a requester appears.
  150.         If MakeDir was clicked with the LEFT button, the
  151.         directory will be created in the source directory.
  152.         If the RIGHT button was used, the new directory goes
  153.         in the destination.
  154.     "Info" Displays the number of USABLE bytes free on each device
  155.         in the window where the device name usually appears.
  156.         (Or free memory in the case of the Ram Disk) If any
  157.         files (NOT directories!) are selected, their total bytes
  158.         and number of x-modem blocks is disp[layed in the status
  159.         window.
  160.     "NewCLI" Will start up a new CLI if Utilimaster can find
  161.         "c:NewCLI". If a filename is selected the result is
  162.         "NewCLI from filename".
  163.  
  164.     All of the "Device" (DF0: DF1: RAM: etc.) buttons may be
  165.         clicked with the LEFT mouse button to get the device
  166.         as the SOURCE directory, or with the RIGHT mouse button
  167.         to get it as the DESTINATION directory. All of these may
  168.         be re-programed to get other devices in the following
  169.         manner:
  170.  
  171.         To change "VD0:" to "VDK:", select (SINGLE-Click) the
  172.         Utilimaster icon on the workbench screen. Select "Info"
  173.         from the workbench menu. Click the "ADD" box next to
  174.         the "ToolTypes" window. Click in the "ToolTypes" box
  175.         and type "VD0:=VDK:" Please note that "VD0:" MUST be
  176.         upper case, but "vdk:" may be lower case if you so
  177.         desire. If you want other text in the button for the
  178.         device, leave a space and enter up to 8 characters.
  179.         EXAMPLE: To change "SYS:" to call your "s:" directory
  180.         with the button lbeled "Scripts" add a tooltype line
  181.         which says "SYS:=s: Scripts"
  182.         EXAMPLE: To change "DH1:" to call up the directory
  183.         "SYS:MyFiles" and the button to display "All Mine"
  184.         add a tooltypes line of "DH1:=sys:myfiles "All Mine"".
  185.         Note that "All Mine" should be entered in the tooltypes
  186.         box in quotes!
  187.  
  188.     UtiliMaster defaults to "SYS:" as the source, and "RAM:" as the
  189.         destination directories on startup. You can change this
  190.         by adding a tooltype line that says
  191.         "DEFAULT=Directory Directory". The first directory
  192.         listed will become the default source, the second
  193.         will become the destination. If only one directory
  194.         name is entered, only SYS: will be changed.
  195.  
  196.     UtiliMaster allows you to dictate a command directory other than
  197.         "c:" To do so add a tooltype line
  198.         "COMMAND=DirectoryName". If the directory does not
  199.         exist, Utilimaster will attempt to create it. Utili-
  200.         Master will then attempt to copy "c:run","c:newcli",
  201.         "c:endcli","c:execute",and "c:assign" into this
  202.         directory. It will then attempt to "assign c: 
  203.         DirectoryName". (This is due to the fact that the
  204.         DOS Execute() command invokes "c:run" in order to
  205.         function. The manx "exec()" commands don't need
  206.         "c:run", but won't function within a program started
  207.         from WorkBench!. They've got us between a rock and a
  208.         hard place!)
  209.         On exiting UtiliMaster, "c:" will be assigned back to
  210.         wherever UtiliMaster found it unless you specify elswhere
  211.         by a tooltype "REASSIGN=DirectoryName".
  212.         If Utilimaster created a new command directory,
  213.         it will be deleted. If you assigned command to
  214.         an existing directory, it will be left intact on
  215.         exiting UtiliMaster. (Including any files
  216.         UtiliMaster copied into it!)
  217.             Other utilities may be copied into your newly
  218.         created command directory via a tooltype
  219.         "COPYLIST=FileName FileName FileName (etc.)". All
  220.         FileNames should include the Device:.
  221.  
  222.     UtiliMaster may be run in "lace" mode by entering "LACE=1"
  223.             as a tooltype entry. This is designed to co-operate
  224.             with Access! (V1.27 and higher) when Access! is
  225.             also in lace mode. Utilimaster then occupies the
  226.             upper half of your display while Access! is in
  227.             the lower half.
  228.  
  229.  
  230.     The clock may be turned off by entering "NOCLOCK=1" as a
  231.         tooltype entry. (For those who don't like clocks!)
  232.  
  233.     There are five more buttons which are disabled unless defined
  234.         by the user as described below.
  235.  
  236.     USER BUTTONS: (Including changes to Show, Print, Arc,
  237.              Search, etc.)
  238.  
  239.     Each of the five user buttons is defined by a tooltype line.
  240.     "USER#=FileName ButtonText flags [Perameters] [PromptText]"
  241.     Where FileName is the FULL directory name of the program to
  242.     invoke.
  243.     ButtonText is the text (up to 8 characters) for the button.
  244.     Flags are desribed below.
  245.     Perameters (up to 20 characters) to pass to function).
  246.     PromptText (up to 30 characters) Is the Text to present in a
  247.       Requester if your program requires user input.
  248.          (Example: A fileName to create). If no promptext
  249.       is provided, no requester will appear.
  250.  
  251.     Flags:
  252.       If your program is simply to be run (Example "run sys:Clock"),
  253.       then add 1 to flags. (You need not enter Perameters or Promptext
  254.       unless you want them. If you DO use perameters, then flags
  255.       should be entered as 0. If promptext is entered you MUST
  256.       enter flags (even if 0) and perameters (even if "")).
  257.       To have your program simply execute while UtiliMaster waits,
  258.           do not add 1. The result is as if typing:
  259.             "CommandName FileName" 
  260.           from CLI for EACH Selected File. If 1 IS added the result is
  261.           like typing:
  262.             "run >NIL: CommandName FileName"
  263.       from CLI for each selected FileName.
  264.       To open a window for your program to output text (It thinks
  265.       it's running from CLI!) add 2. You get a RAW window by default,
  266.       and will have to close it. By default, you must close it after
  267.       EACH filename is processed. To have it remain until all
  268.       selected files have been processed, add 8 to flags.
  269.       If you wish your program to be executed (or run) even with
  270.       no files selected, add 16 to flags.
  271.       If files must be selected:
  272.          Add 64 to allow selected DIRECTORIES to be passed as
  273.          filenames. (If 64 was added, but selection is NOT required,
  274.          in the event you click the button with no selection,
  275.          UtiliMaster will pass the current source directory as a
  276.          filename.)
  277.              Add 32 to flags to have ALL selected filenames in one pass.
  278.          If you've entered parameters they are normally place
  279.          before the filename(s). To have them placed AFTER the 
  280.          filename(s), add 128 to flags.
  281.       If Promptext is entered, you will be prompted for input each
  282.       time you command is invoked (unless you pre-enter it in
  283.       the Entry box). Text entered at the prompt goes into the
  284.       "Entry" buffer and is normally placed AFTER the filenames.
  285.       to place is BEFORE them, add 256 to flags.
  286.       If you want UtiliMaster to update the directory after your
  287.       command has executed, add 512 to flags.
  288.       The number entered for "Flags" should be a total of the above
  289.       depending on what you want to happen.
  290.       EXAMPLES:
  291.       If Flags=0 Then the result of clicking the button will be like
  292.       typing "CommandName filename" from CLI for each selected file.
  293.       No directory names will be passed. If no files are selected,
  294.       clicking this button will be ignored!
  295.     DEFAULT BUTTON SETTINGS:
  296.       Each of the buttons listed may be changed by a tooltypes line.
  297.       These examples show what that line would look like to obtain
  298.     exactly what the default setting for that button is.
  299.  
  300.     PRINT=c:Print Print 0
  301.       "c:Print" is passed a FileName. No directories are
  302.     allowed. Control is not returned to UtiliMaster while "c:Print"
  303.     runs. If Utilimaster can't find  "c:print" (or whatever it's
  304.     been redefined to) an internal routine is used. Printer output
  305.     will be the same as screen format for "Read". The print button
  306.     is a special case. You may re-program it to call any command you
  307.     like, however, if at startup UtiliMaster doesn't find your command,
  308.     when clicked the print button will attempt to print the selected
  309.     file to the printer via an internal routine.
  310.  
  311.     SHOW=c:Show Show 0
  312.       "c:Show is started and passed a FileName. Directories are not
  313.       allowed. Control IS NOT passed back to Utilimaster until
  314.       "Show" is done. This is to prevent Show from being run
  315.       simultaniously for several files.
  316.     SEARCH=c:Search 198 all "What text?"
  317.       A window CON is opened, and the equivelant of typing
  318.         "c:Search FileName <"E" box content> All" takes place.
  319.       If the "E" box is empty, a requester appears whith the prompt
  320.       "What text?". The text then entered is substituted.
  321.     ARC=c:Arc Arc 806 A
  322.         Equivelent CLI line:
  323.           "c:Arc A FileName [FileName] [FileName]"
  324.           Arc is a special case. Filenames are checked for length. If
  325.           length exceeds 12, you will be prompted for a shorter name.
  326.           WARNING: In this case, your file is "Renamed" to the shorter
  327.           name, Arc is run, and your filename is then "Renamed" back
  328.           to it's orriginal name. If UtiliMaster should in some way
  329.           fail, your file may not get renamed back to the orriginal.
  330.     DEARC=c:Arc De-Arc 518 V
  331.         Equivelent CLI line:
  332.           "c:Arc X FileName"
  333.     LISTARC=c:Arc "List Arc" 2 V
  334.         Equivelent CLI line:
  335.           "c:Arc V FileName"
  336.     RUN=c:Run Run 0 >NIL:
  337.         Equivelent CLI line:
  338.           "c:Run >NIL: FileName"
  339.     EDIT=c:E Edit 81
  340.         Equivelent CLI line: (with file selected)
  341.           "c:Run c:E FileName"
  342.         Equivelent CLI line: (with NO file selected)
  343.           "c:Run c:E SourceDirectory"
  344.     EXECUTE=c:Execute Execute 6
  345.         Equivelent CLI line:
  346.           "c:Ececute FileName"
  347.     NEWCLI=c:NewCli "New CLI" 16
  348.         Equivelent CLI line: (with filename)
  349.           "c:Newcli from filename"
  350.         Equivelent CLI line: (with no filename)
  351.           "c:Newcli"
  352.  
  353.     Please note that if a new command directory is defined, then
  354.     in each of the above examples, the new directory name will be
  355.     used in place of "c:".
  356.  
  357.     Also note that any of these may be told to look for the program
  358.     in some other directory. For example, if you keep "Newcli" in
  359.     your "System" directory, you would then use tooltype
  360.       "NEWCLI=System:Newcli "New CLI""
  361.       (Note the quotes around "New CLI" for the button. Utilimaster
  362.       understands quotes and any group of words/letters inside
  363.       quotes is treated as one perameter regardless of spaces.
  364.  
  365.         THE GOOD NEWS: The program in the arc file called UMUtil will
  366.         build an icon to your specifications. You can load the image(s)
  367.         for a simple or alternat image icon from ANY icon (Even a disk's
  368.         icon, or a drawer icon!!) via "Load icon image". Only the image
  369.         is then taken from that icon. If you specify a path in the
  370.     "DefaultTool" window, it builds a "project" icon which when
  371.     click, looks for UtiliMaster under the name entered, and uses
  372.     this icon's tooltypes to set UtiliMasters buttons. You could
  373.     place UtiliMaster in C: for example, and build several icons
  374.     with different arrangements. By entering "C:UtiliMaster" as the
  375.     "DefaultTool" in each of these icons, ONE copy of UtiliMaster
  376.     can be started with a variety of different "setups". In this
  377.     event, however, it is suggested you place one icon in C: with
  378.     YOUR favorite defaults so that "UtiliMaster" from CLI sees it.
  379.     Otherwise, you get MY defaults!
  380.     I reccommend that you use UMUtil to make your icons, as
  381.     Workbench's "info" tends to add tooltype lines together!
  382.     UMUtil does not!
  383.     THE BAD NEWS: UMUtil runs from CLI only! SYNTAX: "UMUtil [iconname]"
  384.         
  385.     Occasionally an error will leave you with what amounts to a
  386.     CLI window opened. You escape this window with "Endcli"
  387.  
  388.     Each time UtiliMaster is started (whether from workbench or CLI!)
  389.         the icon is parsed for all of the above. Some of these
  390.         may be over-ridden when starting from cli as follows:
  391.         
  392.         Utilimaster [noclock] [update | noupdate] [lock | nolock]
  393.             [lace | nolace] [directory] [directory]
  394.         These may be in any order, except that the first string
  395.                 containing a colon (":") will be taken as the opening
  396.         source directory, and the second as opening destination
  397.         directory. You may dictate an icon from which to take
  398.         defaults by typing "UtiliMaster icon iconname". These
  399.         may be mixed into the above in any position PROVIDED
  400.         that "iconname" is the NEXT entry after "icon"!
  401.  
  402.     When run from workbench, Utilimaster opens a background window.
  403.     You may change it's size by tooltype
  404.       "WINDOW=CON:<Left>/<Top>/<Width>/<Height>/"
  405.     If you use this, window MUST be "CON:" and ALL FOUR dimensions
  406.     MUST be given! (Unless you LIKE Guru Errors!)
  407.     There are some programs (The version of "Arc" that I have, for
  408.     example.) which send some of their output to ERROR out instead
  409.     of STANDARD out. This output will go to the background window
  410.     if started from WorkBench or the CLI from which UtiliMaster was
  411.         started. Sorry, I haven't figured out a way around this. You may
  412.         see this output by using the "Window to Front/Back" gadgets.
  413.  
  414.         UtiliMaster is public domain software! (It's based on too
  415.         many predecessors!) A contribution ($10.00) is requested!
  416.  
  417.         Please send comments and/or sugestions (and contributions) to:
  418.                 John Scheib
  419.                 3805 FairWay Circle
  420.                 Las Vegas, Nevada 89108
  421.                 OR
  422.                 The Other BBS (702) 438-3625
  423.                 OR
  424.                 People Link: JSCHEIB
  425.  
  426.     Enjoy UtiliMaster!
  427.